<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>windows::basic_overlapped_handle</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="windows__basic_object_handle__rebind_executor/other.html"
          title="windows::basic_object_handle::rebind_executor::other">
    <link rel="next" href="windows__basic_overlapped_handle/assign.html"
          title="windows::basic_overlapped_handle::assign">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="windows__basic_object_handle__rebind_executor/other.html"><img src="../../prev.png"
                                                                                          alt="Prev"></a><a
        accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h"
                                                                                       href="../../index.html"><img
        src="../../home.png" alt="Home"></a><a accesskey="n" href="windows__basic_overlapped_handle/assign.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.windows__basic_overlapped_handle"></a><a class="link"
                                                                                 href="windows__basic_overlapped_handle.html"
                                                                                 title="windows::basic_overlapped_handle">windows::basic_overlapped_handle</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.windows__basic_overlapped_handle"></a>
    </p>
    <p>
        Provides Windows handle functionality for objects that support overlapped
        I/O.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="Executor1.html"
                                             title="Executor requirements">Executor</a> <span
                class="special">=</span> <span class="identifier">any_io_executor</span><span
                class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">basic_overlapped_handle</span>
</pre>
    <h5>
        <a name="asio.reference.windows__basic_overlapped_handle.h0"></a>
        <span><a name="asio.reference.windows__basic_overlapped_handle.types"></a></span><a class="link"
                                                                                            href="windows__basic_overlapped_handle.html#asio.reference.windows__basic_overlapped_handle.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle__rebind_executor.html"
                           title="windows::basic_overlapped_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Rebinds the handle type to another executor.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/executor_type.html"
                           title="windows::basic_overlapped_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The type of the executor associated with the object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/lowest_layer_type.html"
                           title="windows::basic_overlapped_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        An overlapped_handle is always the lowest layer.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/native_handle_type.html"
                           title="windows::basic_overlapped_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The native representation of a handle.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.windows__basic_overlapped_handle.h1"></a>
        <span><a name="asio.reference.windows__basic_overlapped_handle.member_functions"></a></span><a class="link"
                                                                                                       href="windows__basic_overlapped_handle.html#asio.reference.windows__basic_overlapped_handle.member_functions">Member
        Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/assign.html"
                           title="windows::basic_overlapped_handle::assign"><span
                                class="bold"><strong>assign</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Assign an existing native handle to the handle.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/basic_overlapped_handle.html"
                           title="windows::basic_overlapped_handle::basic_overlapped_handle"><span class="bold"><strong>basic_overlapped_handle</strong></span></a>
                        <span class="silver">[constructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Construct an overlapped handle without opening it. <br> <span class="silver"> —</span><br>
                        Construct an overlapped handle on an existing native handle. <br>
                        <span class="silver"> —</span><br> Move-construct an overlapped handle from another.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/cancel.html"
                           title="windows::basic_overlapped_handle::cancel"><span
                                class="bold"><strong>cancel</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Cancel all asynchronous operations associated with the handle.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/close.html"
                           title="windows::basic_overlapped_handle::close"><span
                                class="bold"><strong>close</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Close the handle.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/get_executor.html"
                           title="windows::basic_overlapped_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the executor associated with the object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/is_open.html"
                           title="windows::basic_overlapped_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Determine whether the handle is open.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/lowest_layer.html"
                           title="windows::basic_overlapped_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const
                        reference to the lowest layer.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/native_handle.html"
                           title="windows::basic_overlapped_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Get the native handle representation.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/operator_eq_.html"
                           title="windows::basic_overlapped_handle::operator="><span
                                class="bold"><strong>operator=</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Move-assign an overlapped handle from another.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.windows__basic_overlapped_handle.h2"></a>
        <span><a name="asio.reference.windows__basic_overlapped_handle.protected_member_functions"></a></span><a
            class="link"
            href="windows__basic_overlapped_handle.html#asio.reference.windows__basic_overlapped_handle.protected_member_functions">Protected
        Member Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="windows__basic_overlapped_handle/_basic_overlapped_handle.html"
                           title="windows::basic_overlapped_handle::~basic_overlapped_handle"><span
                                class="bold"><strong>~basic_overlapped_handle</strong></span></a> <span class="silver">[destructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Protected destructor to prevent deletion through this type.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <p>
        The <a class="link" href="windows__overlapped_handle.html" title="windows::overlapped_handle"><code
            class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span
            class="identifier">overlapped_handle</span></code></a> class provides
        the ability to wrap a Windows handle. The underlying object referred to by
        the handle must support overlapped I/O.
    </p>
    <h5>
        <a name="asio.reference.windows__basic_overlapped_handle.h3"></a>
        <span><a name="asio.reference.windows__basic_overlapped_handle.thread_safety"></a></span><a class="link"
                                                                                                    href="windows__basic_overlapped_handle.html#asio.reference.windows__basic_overlapped_handle.thread_safety">Thread
        Safety</a>
    </h5>
    <p>
        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
    </p>
    <p>
        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
    </p>
    <h5>
        <a name="asio.reference.windows__basic_overlapped_handle.h4"></a>
        <span><a name="asio.reference.windows__basic_overlapped_handle.requirements"></a></span><a class="link"
                                                                                                   href="windows__basic_overlapped_handle.html#asio.reference.windows__basic_overlapped_handle.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code
            class="literal">asio/windows/basic_overlapped_handle.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="windows__basic_object_handle__rebind_executor/other.html"><img src="../../prev.png"
                                                                                          alt="Prev"></a><a
        accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h"
                                                                                       href="../../index.html"><img
        src="../../home.png" alt="Home"></a><a accesskey="n" href="windows__basic_overlapped_handle/assign.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
